| API Documentation |  |

- MAIN PAGE
- NAMESPACES
- CLASSES

RenderContextDescriptor.h
1 // RenderContextDescriptor.h
3 //
5
6 namespace nkGraphics
7 {
13 class RenderContextDescriptor final
14 {
15 public :
16
17 unsigned int _width ;
18 unsigned int _height ;
19
20 union
21 {
22 nkWinUi::GraphicsWindow* _window ;
23 Texture* _texture ;
24 } ;
25
26 bool _offscreenContext ;
27 bool _vsync ;
28
29 public :
30
34 RenderContextDescriptor () noexcept ;
42 RenderContextDescriptor (nkWinUi::Window* window) noexcept ;
50 RenderContextDescriptor (nkGraphics::Texture* texture) noexcept ;
61 RenderContextDescriptor (unsigned int width, unsigned int height, bool forOffscreen, bool vsync = false) noexcept ;
62 } ;
63 }
nkGraphics::RenderContextDescriptor::RenderContextDescriptor
RenderContextDescriptor() noexcept
nkGraphics::RenderContextDescriptor::_window
nkWinUi::GraphicsWindow * _window
For non off-screen context creation, an already existing window can be specified here....
Definition: RenderContextDescriptor.h:22
nkGraphics::RenderContextDescriptor::_height
unsigned int _height
The height of the context, in pixels. Defauls to 1.
Definition: RenderContextDescriptor.h:18
nkGraphics::Texture
A texture used for rendering, hosted on GPU.
Definition: Texture.h:35
nkGraphics::RenderContextDescriptor
A descriptor, used when creating a context along with its window.
Definition: RenderContextDescriptor.h:14
nkGraphics::RenderContextDescriptor::_texture
Texture * _texture
For off-screen context creation, an already existing texture to work on. Defaults to nullptr,...
Definition: RenderContextDescriptor.h:23
nkGraphics::RenderContextDescriptor::_offscreenContext
bool _offscreenContext
If the context should be used for offscreen rendering (no window created, only works with texture)....
Definition: RenderContextDescriptor.h:26
nkGraphics::RenderContextDescriptor::_width
unsigned int _width
The width of the context, in pixels. Defaults to 1.
Definition: RenderContextDescriptor.h:17
nkGraphics
Encompasses all API of component NilkinsGraphics.
Definition: BoundingBox.h:7
nkWinUi
Encompasses all API of component NilkinsWinUi.
Definition: Clipboard.h:7
nkGraphics::RenderContextDescriptor::_vsync
bool _vsync
If the context should be using vsync (true) or not (false). Defaults to false.
Definition: RenderContextDescriptor.h:27